com.inscoper.api.StatusParam¶

StatusParam class pairs a sub-device with a value. More...

Inherited by com.inscoper.api.ParentStatusParam

Public Functions¶

	Name
synchronized void	delete()
	StatusParam(SubDeviceId subDeviceId, Object value)
void	setValue(Object value)
void	addValue(int tag, Object value)
void	addValue(int index, int tag, Object value)
Object	getValue()
SubDeviceId	getSubDeviceId()
void	setSubDeviceId(SubDeviceId subDeviceId)
boolean	equals(Object obj)
	StatusParam(StatusParam other) Copy constructor.
	StatusParam(SubDeviceId subDeviceId) Constructor from sub-device ID.
	StatusParam(SubDeviceId subDeviceId, String value) Constructor from sub-device ID and string value.
	StatusParam(SubDeviceId subDeviceId, char value) Constructor from sub-device ID and char value.
	StatusParam(SubDeviceId subDeviceId, short value) Constructor from sub-device ID and short value.
	StatusParam(SubDeviceId subDeviceId, int value) Constructor from sub-device ID and int value.
	StatusParam(SubDeviceId subDeviceId, java.math.BigInteger value) Constructor from sub-device ID and unsigned long long value.
	StatusParam(SubDeviceId subDeviceId, long value) Constructor from sub-device ID and long long value.
	StatusParam(SubDeviceId subDeviceId, float value) Constructor from sub-device ID and float value.
	StatusParam(SubDeviceId subDeviceId, double value) Constructor from sub-device ID and double value.
	StatusParam(SubDeviceId subDeviceId, boolean value) Constructor from sub-device ID and boolean value.
boolean	hasValue() Check if the status parameter has a value.
String	getStringValue() Get value as string.
char	getCharValue() Get value as char.
short	getShortValue() Get value as short.
int	getIntValue() Get value as int.
java.math.BigInteger	getUnsignedLongValue() Get value as unsigned long long.
long	getLongValue() Get value as long long.
float	getFloatValue() Get value as float.
double	getDoubleValue() Get value as double.
void	setValue(String value) Set value from string.
void	setValue(char value) Set value from char.
void	setValue(short value) Set value from short.
void	setValue(int value) Set value from int.
void	setValue(java.math.BigInteger value) Set value from unsigned long long.
void	setValue(long value) Set value from long long.
void	setValue(float value) Set value from float.
void	setValue(double value) Set value from double.
void	setValue(boolean value) Set value from bool.
void	addValue(int tag, String value) Add a string value for a specific parameter index.
void	addValue(int tag, char value) Add a tagged char value for a specific parameter index.
void	addValue(int tag, short value) Add a tagged short value for a specific parameter index.
void	addValue(int tag, int value) Add a tagged int value for a specific parameter index.
void	addValue(int tag, java.math.BigInteger value) Add a tagged unsigned long long value for a specific parameter index.
void	addValue(int tag, long value) Add a tagged long long value for a specific parameter index.
void	addValue(int tag, float value) Add a tagged float value for a specific parameter index.
void	addValue(int tag, double value) Add a tagged double value for a specific parameter index.
void	addValue(int tag, boolean value) Add a tagged boolean value for a specific parameter index.
void	addValue(int index, int tag, String value) Add a string value associated with a specific parameter index and value index.
void	addValue(int index, int tag, char value) Add a char value associated with a specific parameter index and value index.
void	addValue(int index, int tag, short value) Add a short value associated with a specific parameter index and value index.
void	addValue(int index, int tag, int value) Add an int value associated with a specific parameter index and value index.
void	addValue(int index, int tag, java.math.BigInteger value) Add an unsigned long long value associated with a specific parameter index and value index.
void	addValue(int index, int tag, long value) Add a long long value associated with a specific parameter index and value index.
void	addValue(int index, int tag, float value) Add a float value associated with a specific parameter index and value index.
void	addValue(int index, int tag, double value) Add a double value associated with a specific parameter index and value index.
void	addValue(int index, int tag, boolean value) Add a bool value associated with a specific parameter index and value index.
String	getType() Get type as string (deprecated).
String	print() Get string representation.
EParamType	getValueType() Get value type.
StatusParam	clone() Clone object.
int	getRealType()
StatusParam	createProxy(long cPtr, boolean cMemoryOwn)

Protected Functions¶

	Name
	StatusParam(long cPtr, boolean cMemoryOwn)
void	swigSetCMemOwn(boolean own)
void	finalize()
long	getCPtr(StatusParam obj)

Detailed Description¶

public class com.inscoper.api.StatusParam;

StatusParam class pairs a sub-device with a value.

This class represents a status parameter, associating a specific sub-device with a value.

Public Functions Documentation¶

function delete¶

public synchronized void delete()

Reimplemented by: com.inscoper.api.ChildStatusParam.delete, com.inscoper.api.ModifiableStatusParam.delete, com.inscoper.api.ParentStatusParam.delete

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    Object value
)

function setValue¶

public void setValue(
    Object value
)

function addValue¶

public void addValue(
    int tag,
    Object value
)

function addValue¶

public void addValue(
    int index,
    int tag,
    Object value
)

function getValue¶

public Object getValue()

function getSubDeviceId¶

public SubDeviceId getSubDeviceId()

function setSubDeviceId¶

public void setSubDeviceId(
    SubDeviceId subDeviceId
)

function equals¶

public boolean equals(
    Object obj
)

function StatusParam¶

public StatusParam(
    StatusParam other
)

Copy constructor.

Parameters:

other : The StatusParam to copy

Creates a new StatusParam as a copy of an existing one.

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId
)

Constructor from sub-device ID.

Parameters:

subDeviceId : The sub-device ID

Initializes a new StatusParam for a specific sub-device without a value.

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    String value
)

Constructor from sub-device ID and string value.

Parameters:

subDeviceId : The sub-device ID
value : The associated string value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    char value
)

Constructor from sub-device ID and char value.

Parameters:

subDeviceId : The sub-device ID
value : The associated char value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    short value
)

Constructor from sub-device ID and short value.

Parameters:

subDeviceId : The sub-device ID
value : The associated short value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    int value
)

Constructor from sub-device ID and int value.

Parameters:

subDeviceId : The sub-device ID
value : The associated int value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    java.math.BigInteger value
)

Constructor from sub-device ID and unsigned long long value.

Parameters:

subDeviceId : The sub-device ID
value : The associated unsigned long long value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    long value
)

Constructor from sub-device ID and long long value.

Parameters:

subDeviceId : The sub-device ID
value : The associated long long value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    float value
)

Constructor from sub-device ID and float value.

Parameters:

subDeviceId : The sub-device ID
value : The associated float value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    double value
)

Constructor from sub-device ID and double value.

Parameters:

subDeviceId : The sub-device ID
value : The associated double value

function StatusParam¶

public StatusParam(
    SubDeviceId subDeviceId,
    boolean value
)

Constructor from sub-device ID and boolean value.

Parameters:

subDeviceId : The sub-device ID
value : The associated boolean value

function hasValue¶

public boolean hasValue()

Check if the status parameter has a value.

Return: True if the status parameter has a value, false otherwise

Indicates whether a value has been assigned to this status parameter.

function getStringValue¶

public String getStringValue()

Get value as string.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The string value

Retrieves the status parameter value as a string.

function getCharValue¶

public char getCharValue()

Get value as char.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The char value

Retrieves the status parameter value as a char.

function getShortValue¶

public short getShortValue()

Get value as short.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The short value

Retrieves the status parameter value as a short.

function getIntValue¶

public int getIntValue()

Get value as int.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The int value

Retrieves the status parameter value as an int.

function getUnsignedLongValue¶

public java.math.BigInteger getUnsignedLongValue()

Get value as unsigned long long.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The unsigned long long value

Retrieves the status parameter value as an unsigned long long.

function getLongValue¶

public long getLongValue()

Get value as long long.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The long long value

Retrieves the status parameter value as a long long.

function getFloatValue¶

public float getFloatValue()

Get value as float.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The float value

Retrieves the status parameter value as a float.

function getDoubleValue¶

public double getDoubleValue()

Get value as double.

Exceptions:

InscoperException If error conversion or retrieval fails

Return: The double value

Retrieves the status parameter value as a double.

function setValue¶

public void setValue(
    String value
)

Set value from string.

Parameters:

value : The string value

Assigns a string value to the status parameter.

function setValue¶

public void setValue(
    char value
)

Set value from char.

Parameters:

value : The char value

Assigns a char value to the status parameter.

function setValue¶

public void setValue(
    short value
)

Set value from short.

Parameters:

value : The short value

Assigns a short value to the status parameter.

function setValue¶

public void setValue(
    int value
)

Set value from int.

Parameters:

value : The int value

Assigns an int value to the status parameter.

function setValue¶

public void setValue(
    java.math.BigInteger value
)

Set value from unsigned long long.

Parameters:

value : The unsigned long long value

Assigns an unsigned long long value to the status parameter.

function setValue¶

public void setValue(
    long value
)

Set value from long long.

Parameters:

value : The long long value

Assigns a long long value to the status parameter.

function setValue¶

public void setValue(
    float value
)

Set value from float.

Parameters:

value : The float value

Assigns a float value to the status parameter.

function setValue¶

public void setValue(
    double value
)

Set value from double.

Parameters:

value : The double value

Assigns a double value to the status parameter.

function setValue¶

public void setValue(
    boolean value
)

Set value from bool.

Parameters:

value : The boolean value

Assigns a boolean value to the status parameter.

function addValue¶

public void addValue(
    int tag,
    String value
)

Add a string value for a specific parameter index.

Parameters:

tag : The parameter index
value : The string value

Used for functions with multiple parameters. Adds a string value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    char value
)

Add a tagged char value for a specific parameter index.

Parameters:

tag : The parameter index
value : The char value

Used for functions with multiple parameters. Adds a char value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    short value
)

Add a tagged short value for a specific parameter index.

Parameters:

tag : The parameter index
value : The short value

Used for functions with multiple parameters. Adds a short value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    int value
)

Add a tagged int value for a specific parameter index.

Parameters:

tag : The parameter index
value : The int value

Used for functions with multiple parameters. Adds an int value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    java.math.BigInteger value
)

Add a tagged unsigned long long value for a specific parameter index.

Parameters:

tag : The parameter index
value : The unsigned long long value

Used for functions with multiple parameters. Adds an unsigned long long value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    long value
)

Add a tagged long long value for a specific parameter index.

Parameters:

tag : The parameter index
value : The long long value

Used for functions with multiple parameters. Adds a long long value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    float value
)

Add a tagged float value for a specific parameter index.

Parameters:

tag : The parameter index
value : The float value

Used for functions with multiple parameters. Adds a float value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    double value
)

Add a tagged double value for a specific parameter index.

Parameters:

tag : The parameter index
value : The double value

Used for functions with multiple parameters. Adds a double value for a specific parameter index.

function addValue¶

public void addValue(
    int tag,
    boolean value
)

Add a tagged boolean value for a specific parameter index.

Parameters:

tag : The parameter index
value : The boolean value

Used for functions with multiple parameters. Adds a bool value for a specific parameter index.

function addValue¶

public void addValue(
    int index,
    int tag,
    String value
)

Add a string value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The string value

Used for functions with multiple parameters to be called several times with different values. Adds a string value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    char value
)

Add a char value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The char value

Used for functions with multiple parameters to be called several times with different values. Adds a char value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    short value
)

Add a short value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The short value

Used for functions with multiple parameters to be called several times with different values. Adds a short value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    int value
)

Add an int value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The int value

Used for functions with multiple parameters to be called several times with different values. Adds an int value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    java.math.BigInteger value
)

Add an unsigned long long value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The unsigned long long value

Used for functions with multiple parameters to be called several times with different values. Adds an unsigned long long value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    long value
)

Add a long long value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The long long value

Used for functions with multiple parameters to be called several times with different values. Adds a long long value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    float value
)

Add a float value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The float value

Used for functions with multiple parameters to be called several times with different values. Adds a float value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    double value
)

Add a double value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The double value

Used for functions with multiple parameters to be called several times with different values. Adds a double value associated with a specific parameter index and value index.

function addValue¶

public void addValue(
    int index,
    int tag,
    boolean value
)

Add a bool value associated with a specific parameter index and value index.

Parameters:

index : The value index
tag : The parameter index
value : The bool value

Used for functions with multiple parameters to be called several times with different values. Adds a bool value associated with a specific parameter index and value index.

function getType¶

public String getType()

Get type as string (deprecated).

Return: The type string

function print¶

public String print()

Get string representation.

Return: The string representation

Retrieves a string representation of the status parameter.

function getValueType¶

public EParamType getValueType()

Get value type.

Exceptions:

InscoperException If error occurs

Return: The parameter type

Retrieves the type of the value stored in this parameter.

function clone¶

public StatusParam clone()

Clone object.

Return: The copy

Reimplemented by: com.inscoper.api.ChildStatusParam.clone, com.inscoper.api.ModifiableStatusParam.clone

Creates a deep copy of this StatusParam.

function getRealType¶

public int getRealType()

Reimplemented by: com.inscoper.api.ParentStatusParam.getRealType

function createProxy¶

public static StatusParam createProxy(
    long cPtr,
    boolean cMemoryOwn
)

Reimplemented by: com.inscoper.api.ParentStatusParam.createProxy

Protected Functions Documentation¶

function StatusParam¶

protected StatusParam(
    long cPtr,
    boolean cMemoryOwn
)

function swigSetCMemOwn¶

protected void swigSetCMemOwn(
    boolean own
)

Reimplemented by: com.inscoper.api.ChildStatusParam.swigSetCMemOwn, com.inscoper.api.ModifiableStatusParam.swigSetCMemOwn, com.inscoper.api.ParentStatusParam.swigSetCMemOwn

function finalize¶

protected void finalize()

Reimplemented by: com.inscoper.api.ChildStatusParam.finalize, com.inscoper.api.ModifiableStatusParam.finalize, com.inscoper.api.ParentStatusParam.finalize

function getCPtr¶

protected static long getCPtr(
    StatusParam obj
)

Updated on 2026-04-02 at 10:55:38 +0200